home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / drc20.zip / README.SRC < prev    next >
Text File  |  1992-08-16  |  23KB  |  628 lines
  1. %%*
  2. %%*  README.SRC
  3. %%*  User's guide for David's Readme Compiler v2.0
  4. %%*  (c) 1991, 1992, David Harris, all rights reserved.
  5. %%*
  6. %%*  Compile an executable readme from this file using
  7. %%*  the command 'RCOM README.SRC'.
  8. %%*
  9. %%*
  10. %%*      This line is a comment.
  11. %%*      Note that because of the particular way this file is
  12. %%*      parsed, blank lines ARE significant.
  13. %%*
  14. %%*      The next line is the title for the main screen.
  15. %%*
  16. %%Title             0, David's Readme Compiler v2.0 - User's Guide
  17. %%*
  18. %%*
  19. %%*      The next statement specifies an opening screen, which is 
  20. %%*      presented to the user when the program is run.
  21. %%*
  22. %%Opening_screen    2000
  23. %%*
  24. %%*      Now we'll actually declare the opening screen. For
  25. %%*      performance reasons, it should be placed as close
  26. %%*      to the start of the file as possible.
  27. %%*
  28. %% 2000, 0, 0, 0, 8, Welcome to David's Readme Compiler v2
  29.  
  30. David's Readme Compiler allows you to create standalone guides,
  31. readme files, and other textual references.
  32.  
  33. Version 2 of DRC supports many new features: if you currently
  34. use DRC v1, please examine the section "What's new in DRC v2"
  35. on the main menu.
  36. %%*
  37. %%*
  38. %%*      Now we'll define a status line for the main screen:
  39. %%*
  40. %%Status_line       2001
  41. %%*
  42. %% 2001, 0, 7, Status line
  43.             David's Readme Compiler, (c) 1991, 1992, David Harris.
  44. %%*
  45. %%*
  46. %%*      Next, define a screen which DRC can present when the
  47. %%*      user asks to edit a topic using the <F10> menu
  48. %%*
  49. %%Edit_screen   2002
  50. %%*
  51. %% 2002, 0, 87, 87, Editing a topic
  52.  
  53. While you edit this topic, the following keys are
  54. available for your use:
  55.  
  56.    Arrows:       move in the indicated direction
  57.    Ctrl-Arrows:  move a word at a time
  58.    PgUp/PgDn:    move a screen at a time
  59.    Tab:          moves to the next field on the screen:
  60.                  a field is anything starting with a
  61.                  left square bracket ([). This feature
  62.                  is handy for designing forms which the
  63.                  user is to complete.
  64.    Ctrl-Y:       delete the current line
  65.    Del, Bks:     delete char right, delete char left
  66.    Ins:          toggle insert mode (defaults to OFF)
  67.  
  68. %%*
  69. %%*
  70. %%*      And lastly we'll set the default flags values for
  71. %%*      the whole script. We'll use the value 7, which indicates
  72. %%*      that the user can Edit, Save, and Print the readme screens.
  73. %%*
  74. %%Default_flags     7
  75. %%*
  76. %%*
  77. %%*      The next line is the first top-level entry in the file (note
  78. %%*      the type of 0). The second integer means that this entry leads
  79. %%*      to a sub-menu of items of type 100 in the file.
  80. %%*
  81. %% 0, 100, About the Readme Compiler
  82. %%*
  83. %%*
  84. %%*      The next entry is a top level item with no sub-entries: when
  85. %%*      selected, its associated text will display at once.
  86. %%*
  87. %% 0, 0, Installing the Readme Compiler
  88.  
  89. To install David's Readme Compiler, place the files
  90. README.BIN and RCOM.EXE in a directory somewhere.
  91. Actual location doesn't matter, so long as both are
  92. in the same place. If you intend to use the -s switch
  93. to RCOM to create simple readmes (ie, readmes without
  94. extended searching and formatting features) then you
  95. should also copy README1.BIN to the same location.
  96.  
  97. The programs can be on the path if you wish, but
  98. they don't have to be, provided they are all in
  99. the same directory.
  100. %%*
  101. %%*
  102. %%*      The next line is an index entry for items of
  103. %%*      type 300: when it is selected, all the items
  104. %%*      of type 300 in the file will be collected into
  105. %%*      a menu and displayed. Notice that the index
  106. %%*      entry itself has no associated text.
  107. %%*
  108. %% 0, 300, Creating a Readme source file
  109. %%*
  110. %% 0, 25, Using David's Readme Compiler
  111. %%*
  112. %% 25, 0, Compiling the source file
  113.  
  114. To create a standalone guide, enter the command
  115.  
  116.          RCOM <filename>
  117.  
  118. where <filename> is the name of the source file you
  119. have created. RCOM will make a temporary file, and
  120. will then bind it to README.BIN as a .EXE file with
  121. the same name as the input file. That's all there 
  122. is to it!
  123. %%*
  124. %% 25, 0, Simplified Readmes
  125.  
  126. David's Readme Compiler allows you to create two types of
  127. readme; the usual readme has full searching capabilities,
  128. a number of extra formatting features, and enhanced print
  129. facilities, including PostScript printing.
  130.  
  131. If the size of the final readme is critical, or you don't
  132. need the extra capabilities, you can have DRC create a
  133. simplified readme by using the -S switch on the command
  134. line. A Simplified readme is about 10KB smaller than a
  135. standard readme, but is much less capable.
  136.  
  137.     Example:  RCOM -s <filename>
  138.  
  139. Standard and simplified readmes can be created from the
  140. same file - the syntax is common.
  141. %%*
  142. %% 25, 0, To clear or not to clear...
  143.  
  144. By default, DRC clears and paints the screen, but you can
  145. force it to come up over the top of the current screen by
  146. by invoking it with a /S switch: when it terminates, the
  147. screen will be left as it was on entry. This is useful if
  148. you want to use DRC to generate a help system which is
  149. spawned by a parent program.
  150. %%*
  151. %% 25, 0, Running the compiled readme
  152.  
  153. Once you have compiled and bound your readme, you can use
  154. it at once simply by typing its name. 
  155. %%*
  156. %% 25, 0, Using the compiled readme
  157.  
  158. When your readme is running, the user will normally use it like
  159. a simple menu-driven application. When the user hightlights an
  160. option in a topic list and presses <Enter>, either another list
  161. will appear, or the actual text of the entry. Pressing <Esc>
  162. steps back to the previous list.
  163.  
  164. At any time the user can press <F10>, which will popup a menu
  165. containing the options which are available at the time. From
  166. a list, only the search options are ever available. From the
  167. text of a topic, the search options and any others you have
  168. enabled will be present in the menu. By default, options other
  169. than the search options are disabled, but you can enable them
  170. on a case-by-case basis, or globally, using the %%D operator
  171. in the source file.
  172. %%*
  173. %% 25, 0, Searching for text
  174.  
  175. The user can search for text in the readme either by selecting
  176. Find text from the option menu, or by pressing <F7>. The
  177. search options cannot be disabled - they are always available.
  178. The Find text operation always starts at the beginning of the
  179. readme, while the Find again option starts after the last
  180. find. A short-cut for Find again is the <F8> key.
  181.  
  182. Searches are case-insensitive - so NETWare is matched the same
  183. as NetWare.
  184. %%*
  185. %% 25, 0, Printing a topic's text
  186.  
  187. If you have enabled printing on an option, then the user can
  188. select Print from the options menu. A small dialog will
  189. appear allowing the user to choose a printer port, and to
  190. indicate whether the printer is a PostScript printer. The
  191. values for each setting can be changed by pressing <Space>,
  192. and the user can move between fields using the arrow keys.
  193.  
  194. DRC's printing is not fancy, but it's functional.
  195. %%*
  196. %% 25, 0, Editing a topic's text
  197.  
  198. If you have enabled editing for an option, then the user
  199. can choose Edit from the options menu. If you have defined
  200. an edit-mode screen using the %%E operator, it will appear
  201. as soon as the choice is made.
  202.  
  203. DRC's editing facilities are not extensive, but they are
  204. perfectly adequate for allowing a user to fill in an order
  205. form or a questionnaire. While editing, the following
  206. keys are available:
  207.  
  208.    Arrows:       move in the indicated direction
  209.    Ctrl-Arrows:  move a word at a time
  210.    PgUp/PgDn:    move a screen at a time
  211.    Tab:          moves to the next field on the screen:
  212.                  a field is anything starting with a
  213.                  left square bracket ([). This feature
  214.                  is handy for designing forms which the
  215.                  user is to complete.
  216.    Ctrl-Y:       delete the current line
  217.    Del, Bks:     delete char right, delete char left
  218.    Ins:          toggle insert mode (defaults to OFF)
  219. %%*
  220. %% 25, 0, Saving a topic's text
  221.  
  222. If you have enabled saving for an entry, this choice on
  223. the option menu will allow the user to save the conte